/**
 * Copyright (C) 2010 altuure <altuure [AT] gmail [DOT] com> http://www.altuure.com/projects/yagdao
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.altuure.yagdao;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * dao method parameter.
 * @author altuure
 */
@Target({ ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
public @interface YParameter {

    /**
     * related parameter name.
     * @return property or parameter name
     */
    String value() default "";

    /**
     * operator for criteria builder methods.
     * @return operator name
     */
    
    YOperator operator() default YOperator.EQUAL;

    /**
     * accept null as a valid input;
     * @return is null valid
     */
    boolean acceptNull() default false;



    /**
     * inverse operator.
     * @return to inverse
     */
    boolean not() default false;

}
